home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
TPUG - Toronto PET Users Group
/
TPUG Users Group CD
/
TPUG Users Group CD.iso
/
AMIGA
/
AMICUS
/
AMICUS08.ADF
/
Progs
/
AmigaSpell.DOC
< prev
next >
Wrap
Text File
|
1986-04-02
|
7KB
|
150 lines
AmigaSpell Documentation - 27 Mar 86
====================================
(C) 1986 by Mike Berro [73267,3361]
BCS Software
13432 Lochrin Lane
Sylmar, CA 91342
AmigaSpell is for the use of CompuServe subscribers and friends. Back it up,
give it away, but do not sell it or post it onto any BBS. Thanx!
Please note that the Beta Test Version allows a maximum of 3000 words in the
glossary. The final version will allow about 35,000 on a 512K machine.
Acknowledgements
----------------
I would like to thank David Haynie, Bruce Bowen, Rob Peck (for "simple"),
Larry Philips, Scott Ballantyne, Amiga Engineering, and everyone else in
the AmigaForum who contributed directly or indirectly to this program.
This program is not based on any other spelling program, because I have
never had the privilege of seeing one. If you have any suggestions, please
leave me a message on Compuserve. I will also be happy to answer any
questions about the program.
Features
--------
* Use it from Workbench or CLI. Optional extended selection lets you avoid
having to type in the filename.
* Analyze a file or an individual word.
* Finds the closest word using a custom string compare function (the only
original function in the program).
* Prints a list of mis-spelled words and closest word.
* Prints the entire glossary - 500 words per page.
* Analyzes ALL files - text, binary, MBS, data.
* Allows you to add words that it finds but does not know.
* The glossary file is a standard text file that you can examine and modify.
How to Use It
-------------
From the Workbench, activate AmigaSpell by moving the pointer over the icon
and then press the left mouse button twice quickly. You can skip a few
steps by using extended selection to select a single file for analyzing (see
below).
From CLI, just type "Run AmigaSpell". You can skip a few steps by typing the
filename to be analyzed after it on the same line. If so, the program will
proceed directly to ANALYZE A FILE, described below.
The AmigaSpell Window will appear, and then the copyright notice. At the
bottom of the screen the number of words in the glossary will be
displayed. If the glossary file is not on the disk, AmigaSpell will
create one that contains two words, AMIGA and SPELL. This file is called
"AmigaSpell.data".
You are then prompted to make a selection from the menu. There are five
items on the menu, ANALYZE A FILE, ANALYZE A WORD, SORT THE GLOSSARY,
PRINT THE GLOSSARY, and QUIT. Selecting quit does the same thing as
selecting the close gadget in the upper-left corner of the window. All files
are closed, all memory used by the program is freed, and the window is
closed. You may close the window any time the program is requesting an
input from you.
Please note that any time you are asked for an input, you may also make a
selection from the menu. "Escape" or "Done" will save the new dictionary
words (if any), "Abort" will return directly to the copyright notice.
ANALYZE A FILE
--------------
Selecting this function causes the program to check the file you enter from
the keyboard for spelling errors. If you have already selected a file from
Workbench or CLI, you will not have to type in the filename. If not, you
must enter the filename from the keyboard. Press the ESC key (or select it
from the menu) to return to the copyright notice.
While the program analyzes the file, each word is displayed in white, and
the words "found" or "not found" will follow as approriate. A 15K file may
take up to two minutes to analyze, so you can do other tasks while it is
working. Please note that a 1500 word glossary uses 30K of memory, which
is not released until the file is completely analyzed.
When the program has finished analyzing the file, it will present each word
it has not found one at a time, as well as the word that comes closest to it
in the glossary (it is not necessary for the glossary to be sorted for
this to occur). It will present the word only once, even if the word occurs
several times in the file. The program will then inquire if you want to
add the word to the glossary. If you do just press "y", otherwise press
"n". If you make a mistake, you can go back to the previous word by
pressing the BACK SPACE key. You can press the ESC key to abort. AmigaSpell
will continue in this manner until all the unmatched words are accounted for.
If you have added words to the glossary, the glossary will then be saved
onto the disk.
You are then asked if you would like a printout of all unmatched words that
were not added to the glossary. Presumably these are the misspelled
words. If you press "y", you will get a printout of each unmatched word and
the closest word found. If you press "n" the program will return to the
copyright notice, unless you have specified a file from Workbench or CLI.
In that case the program will end, and the window will close.
ANALYZE A WORD
--------------
This function works the same as ANALYZE A FILE, except that you enter each
word from the keyboard. To exit this function, press RETURN instead of
entering a word, or select DONE from the menu.
If you exit when you are being requested for a word, any words you have
added to the glossary will be saved on the disk, and you can print out the
words you have not added (if any). If you select ABORT from the menu when
you are being asked whether or not to add a word, you will return
immediately to the copyright notice.
SORT THE GLOSSARY
-----------------
This function simply sorts the words in the file "AmigaSpell.data". It does
this by creating a file called "AmigaSpell.data.temp", so make sure you have
room on the disk for this temporary file. The temporary file is deleted at
the end of the sort process.
PRINT THE GLOSSARY
------------------
This function prints the file "AmigaSpell.data". The program tries to fit
as many words as possible on a single line (separated by a single space) in
order to conserve paper.
Adding and Deleting Words
-------------------------
You can add and delete words by editing the file "AmigaSpell.data" using "ed"
from the CLI or TextCraft(tm). If you use TextCraft, make sure you save the
file as a "text only" file. Also, make sure every word you add is in upper
case, or AmigaSpell will ignore it. AmigaSpell also ignores words shorter
the 3 or longer than 18 letters.